Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: course outline not found issue for ccx courses #36128

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Anas12091101
Copy link
Contributor

@Anas12091101 Anas12091101 commented Jan 17, 2025

Description

This PR adds cms.djangoapps.contentstore.apps.ContentstoreConfig in INSTALLED_APPS for CCX feature in production settings. Without this, the course publish signals are not triggerred at the time of CCX creation resulting in a CourseOutlineData.DoesNotExist error for the CCX courses.

Useful information to include:

  • Which edX user roles will this change impact? "Learner", "Course Author"
  • Provide links to the description of corresponding configuration changes. Remember to correctly annotate these
    changes.

Supporting information

https://github.com/mitodl/hq/issues/3880

Testing instructions

To test this locally, follow the steps below

  • In your private.py in LMS, add these settings to enable CCX:
FEATURES["CUSTOM_COURSES_EDX"]=True
INSTALLED_APPS += ['lms.djangoapps.ccx', 'openedx.core.djangoapps.ccxcon.apps.CCXConnectorConfig']
COURSE_IMPORT_EXPORT_STORAGE = 'django.core.files.storage.FileSystemStorage'
COURSEGRAPH_DUMP_COURSE_ON_PUBLISH = False
MODULESTORE_FIELD_OVERRIDE_PROVIDERS += ('lms.djangoapps.ccx.overrides.CustomCoursesForEdxOverrideProvider',)
  • In your private.py in CMS, add this setting:
FEATURES["CUSTOM_COURSES_EDX"]=True
  • In Studio, create a course and go to advanced settings. Toggle the "Enable CCX" setting there.

  • Next, go to the course's instructor dashboard, open the membership tab, and add a CCX coach.

  • Log in as the CCX coach, open the course you created, go to the CCX coach tab, and create a CCX. (You can find all the steps to create a CCX in the docs).

  • Save your changes in the Schedule Tab, then check the course outline of the CCX course.

    • You’ll notice the course outline won’t load, and you’ll see a CourseOutlineData.DoesNotExist error in your LMS logs.
  • To fix this, update the INSTALLED_APPS line in LMS settings to:

INSTALLED_APPS += ['lms.djangoapps.ccx', 'openedx.core.djangoapps.ccxcon.apps.CCXConnectorConfig', 'cms.djangoapps.contentstore.apps.ContentstoreConfig', 'openedx.core.djangoapps.content.search', 'openedx.core.djangoapps.content_staging']
  • Go back to the Schedule Tab, make any changes, and save again.

  • Finally, revisit the course outline page of the CCX course.

    • The outline will now load perfectly without any errors.

Deadline

"None"

Other information

Include anything else that will help reviewers and consumers understand the change.

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.
  • If your database migration can't be rolled back easily.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 17, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Jan 17, 2025

Thanks for the pull request, @Anas12091101!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@Anas12091101 Anas12091101 force-pushed the anas/fix-ccx branch 2 times, most recently from 5713d56 to 3321319 Compare January 17, 2025 14:55
@Anas12091101 Anas12091101 marked this pull request as draft January 17, 2025 14:55
@Anas12091101 Anas12091101 force-pushed the anas/fix-ccx branch 2 times, most recently from f374d81 to 4fdfece Compare January 17, 2025 15:32
@Anas12091101 Anas12091101 marked this pull request as ready for review January 17, 2025 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Needs Triage
Development

Successfully merging this pull request may close these issues.

2 participants